Skip to main content
POST
/
tools
/
credentials
Create Tool Credential
curl --request POST \
  --url https://agent-prod.studio.lyzr.ai/v3/tools/credentials \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "provider_id": "<string>",
  "credentials": {},
  "meta_data": {}
}
'
{
  "message": "Credential created successfully."
}

​
Description

This endpoint creates a new credential for a tool.

​
Endpoint

POST /v3/tools/credentials

​
Authentication

API Key (x-api-key) must be included in the header.

​
Request Body

{
  "name": "string",
  "provider_id": "string",
  "credentials": {},
  "meta_data": {}
}

​
Response

A message confirming that the credential was created.

​
Example Request

curl -X POST "https://agent-prod.studio.lyzr.ai/v3/tools/credentials" ^
-H "accept: application/json" ^
-H "content-type: application/json" ^
-H "x-api-key: sk-default-EXAMPLEKEY123" ^
-d "{\"name\":\"string\",\"provider_id\":\"string\",\"credentials\":{},\"meta_data\":{}}"

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

The name of the credential.

​
provider_id
string
required

The provider ID this credential is associated with.

​
credentials
object
required

Key-value pairs of the actual credentials.

​
meta_data
object

Additional metadata related to the credential.

Response

Credential created successfully

​
message
string
Example:

"Credential created successfully."